| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351 |
1
60
60
1119
1119
1119
2180
1099
2180
1119
60
26
52
26
60
60
180
180
180
60
120
180
60
60
60
60
60
60
60
60
60
60
60
60
60
60
60
20
60
40
60
60
60
60
60
60
60
40
21
21
21
60
120
120
60
2005
3348
60
8
16
8
60
60
26
60
5
60
331
331
160
331
60
279
279
122
279
60
1054
60
3
3
3
6
3
3
60
26
26
26
26
26
26
26
26
26
23
26
1
1
1
1
1
1
26
26
26
60
60
80
40
80
20
60
60
60
60
60
60
3
3
3
3
3
3
3
60
2
2
2
2
2
2
2
| /**
* @ngdoc directive
* @name patternfly.wizard.component:pfWizardStep
* @restrict E
*
* @description
* Component for rendering a Wizard step. Each step can stand alone or have substeps. This directive can only be used as a child of pf-wizard.
*
* @param {string} stepTitle The step title displayed in the header and used for the review screen when displayed
* @param {string} stepId Sets the text identifier of the step
* @param {number} stepPriority This sets the priority of this wizard step relative to other wizard steps. They should be numbered sequentially in the order they should be viewed.
* @param {boolean} substeps Sets whether this step has substeps
* @param {boolean=} nextEnabled Sets whether the next button should be enabled when this step is first displayed
* @param {boolean=} prevEnabled Sets whether the back button should be enabled when this step is first displayed
* @param {string=} nextTooltip The text to display as a tooltip on the next button
* @param {string=} prevTooltip The text to display as a tooltip on the back button
* @param {boolean=} wzDisabled Hides the step when set to True
* @param {boolean} okToNavAway Sets whether or not it's ok for the user to leave this page
* @param {boolean} allowClickNav Sets whether the user can click on the numeric step indicators to navigate directly to this step
* @param {string=} description The step description (optional)
* @param {object} wizardData Data passed to the step that is shared by the entire wizard
* @param {function()=} onShow The function called when the wizard shows this step
* @param {object=} focusSelectors Array of selectors to be used (in the order given) to find the initial focus component for the page
* @param {boolean=} showReview Indicates whether review information should be displayed for this step when the review step is reached
* @param {boolean=} showReviewDetails Indicators whether the review information should be expanded by default when the review step is reached
* @param {string=} reviewTemplate The template that should be used for the review details screen
*/
angular.module('patternfly.wizard').component('pfWizardStep', {
transclude: true,
bindings: {
stepTitle: '@',
stepId: '@',
stepPriority: '@',
substeps: '=?',
nextEnabled: '<?',
prevEnabled: '<?',
nextTooltip: '<?',
prevTooltip: '<?',
disabled: '@?wzDisabled',
okToNavAway: '<?',
allowClickNav: '<?',
description: '@',
wizardData: '=',
onShow: '=?',
focusSelectors: '<?',
showReview: '@?',
showReviewDetails: '@?',
reviewTemplate: '@?'
},
templateUrl: 'wizard/wizard-step.html',
controller: function ($timeout, $scope) {
'use strict';
var ctrl = this,
firstRun;
var stepIdx = function (step) {
var idx = 0;
var res = -1;
angular.forEach(ctrl.getEnabledSteps(), function (currStep) {
if (currStep === step) {
res = idx;
}
idx++;
});
return res;
};
var unselectAll = function () {
//traverse steps array and set each "selected" property to false
angular.forEach(ctrl.getEnabledSteps(), function (step) {
step.selected = false;
});
//set selectedStep variable to null
ctrl.selectedStep = null;
};
var stepByTitle = function (titleToFind) {
var foundStep = null;
angular.forEach(ctrl.getEnabledSteps(), function (step) {
if (step.stepTitle === titleToFind) {
foundStep = step;
}
});
return foundStep;
};
var findWizard = function (scope) {
var wizard;
Eif (scope) {
if (angular.isDefined(scope.wizard)) {
wizard = scope.wizard;
} else {
wizard = findWizard(scope.$parent);
}
}
return wizard;
};
ctrl.$onInit = function () {
firstRun = true;
ctrl.steps = [];
ctrl.context = {};
ctrl.title = ctrl.stepTitle;
ctrl.wizard = findWizard($scope.$parent);
ctrl.contentStyle = ctrl.wizard.contentStyle;
// Provide wizard step controls to sub-steps
$scope.wizardStep = this;
ctrl.wizard.addStep(ctrl);
ctrl.pageNumber = ctrl.wizard.getStepNumber(ctrl);
Eif (angular.isUndefined(ctrl.nextEnabled)) {
ctrl.nextEnabled = true;
}
Eif (angular.isUndefined(ctrl.prevEnabled)) {
ctrl.prevEnabled = true;
}
if (angular.isUndefined(ctrl.showReview)) {
ctrl.showReview = false;
}
if (angular.isUndefined(ctrl.showReviewDetails)) {
ctrl.showReviewDetails = false;
}
Iif (angular.isUndefined(ctrl.stepPriority)) {
ctrl.stepPriority = 999;
} else {
ctrl.stepPriority = parseInt(ctrl.stepPriority);
}
Eif (angular.isUndefined(ctrl.okToNavAway)) {
ctrl.okToNavAway = true;
}
Eif (angular.isUndefined(ctrl.allowClickNav)) {
ctrl.allowClickNav = true;
}
if (ctrl.substeps && !ctrl.onShow) {
ctrl.onShow = function () {
$timeout(function () {
Eif (!ctrl.selectedStep) {
ctrl.goTo(ctrl.getEnabledSteps()[0]);
}
}, 10);
};
}
};
ctrl.$onChanges = function (changesObj) {
Iif (changesObj.nextTooltip) {
if (_.get(ctrl.wizard, 'selectedStep') === ctrl) {
ctrl.wizard.nextTooltip = changesObj.nextTooltip.currentValue;
}
}
Iif (changesObj.prevTooltip) {
if (_.get(ctrl.wizard, 'selectedStep') === ctrl) {
ctrl.wizard.prevTooltip = changesObj.prevTooltip.currentValue;
}
}
};
ctrl.getEnabledSteps = function () {
return ctrl.steps.filter(function (step) {
return step.disabled !== 'true';
});
};
ctrl.getReviewSteps = function () {
var reviewSteps = ctrl.getEnabledSteps().filter(function (step) {
return !angular.isUndefined(step.reviewTemplate);
});
return reviewSteps;
};
ctrl.resetNav = function () {
ctrl.goTo(ctrl.getEnabledSteps()[0]);
};
ctrl.currentStepNumber = function () {
//retrieve current step number
return stepIdx(ctrl.selectedStep) + 1;
};
ctrl.getStepNumber = function (step) {
return stepIdx(step) + 1;
};
ctrl.isNextEnabled = function () {
var enabled = angular.isUndefined(ctrl.nextEnabled) || ctrl.nextEnabled;
if (ctrl.substeps && ctrl.selectedStep) {
enabled = enabled && ctrl.selectedStep.isNextEnabled();
}
return enabled;
};
ctrl.isPrevEnabled = function () {
var enabled = angular.isUndefined(ctrl.prevEnabled) || ctrl.prevEnabled;
if (ctrl.substeps && ctrl.selectedStep) {
enabled = enabled && ctrl.selectedStep.isPrevEnabled();
}
return enabled;
};
ctrl.getStepDisplayNumber = function (step) {
return ctrl.pageNumber + String.fromCharCode(65 + stepIdx(step)) + ".";
};
ctrl.prevStepsComplete = function (nextStep) {
var nextIdx = stepIdx(nextStep);
var complete = true;
angular.forEach(ctrl.getEnabledSteps(), function (step, stepIndex) {
if (stepIndex < nextIdx) {
complete = complete && step.nextEnabled;
}
});
return complete;
};
ctrl.goTo = function (step) {
var focusElement = null;
Iif (ctrl.wizard.isWizardDone() || !step.okToNavAway || step === ctrl.selectedStep) {
return;
}
Eif (firstRun || (ctrl.getStepNumber(step) < ctrl.currentStepNumber() && ctrl.selectedStep.prevEnabled) || ctrl.prevStepsComplete(step)) {
unselectAll();
ctrl.selectedStep = step;
Eif (step) {
step.selected = true;
ctrl.wizard.setPageSelected(step);
if (angular.isFunction (ctrl.selectedStep.onShow)) {
ctrl.selectedStep.onShow();
}
// Give time for onShow to do its thing (maybe update the selectors), then time to display the elements
$timeout(function () {
Iif (step.focusSelectors) {
_.find(step.focusSelectors, function (selector) {
return focusElement = document.querySelector(selector);
});
}
// Default to next button if it is enabled
Eif (!focusElement && step.nextEnabled) {
focusElement = document.querySelector('.wizard-pf-next');
}
// Use cancel button if we haven't found anything else to set focus on
Eif (!focusElement) {
focusElement = document.querySelector('.wizard-pf-cancel');
}
Iif (focusElement) {
focusElement.focus();
}
}, 300);
ctrl.currentStep = step.stepTitle;
firstRun = false;
}
ctrl.wizard.updateSubStepNumber (stepIdx(ctrl.selectedStep));
}
};
ctrl.stepClick = function (step) {
if (step.allowClickNav) {
ctrl.goTo(step);
}
};
ctrl.addStep = function (step) {
// Insert the step into step array
var insertBefore = _.find(ctrl.steps, function (nextStep) {
return nextStep.stepPriority > step.stepPriority;
});
if (insertBefore) {
ctrl.steps.splice(ctrl.steps.indexOf(insertBefore), 0, step);
} else {
ctrl.steps.push(step);
}
};
ctrl.currentStepTitle = function () {
return ctrl.selectedStep.stepTitle;
};
ctrl.currentStepDescription = function () {
return ctrl.selectedStep.description;
};
ctrl.currentStep = function () {
return ctrl.selectedStep;
};
ctrl.totalStepCount = function () {
return ctrl.getEnabledSteps().length;
};
// Method used for next button within step
ctrl.next = function (callback) {
var enabledSteps = ctrl.getEnabledSteps();
// Save the step you were on when next() was invoked
var index = stepIdx(ctrl.selectedStep);
// Check if callback is a function
Eif (angular.isFunction (callback)) {
Eif (callback(ctrl.selectedStep)) {
Iif (index === enabledSteps.length - 1) {
return false;
}
// Go to the next step
ctrl.goTo(enabledSteps[index + 1]);
return true;
}
return true;
}
// Completed property set on scope which is used to add class/remove class from progress bar
ctrl.selectedStep.completed = true;
// Check to see if this is the last step. If it is next behaves the same as finish()
if (index === enabledSteps.length - 1) {
return false;
}
// Go to the next step
ctrl.goTo(enabledSteps[index + 1]);
return true;
};
ctrl.previous = function (callback) {
var index = stepIdx(ctrl.selectedStep);
var goPrev = false;
// Check if callback is a function
Eif (!angular.isFunction (callback) || callback(ctrl.selectedStep)) {
Eif (index !== 0) {
ctrl.goTo(ctrl.getEnabledSteps()[index - 1]);
goPrev = true;
}
}
return goPrev;
};
}
});
|